-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
✍️ Initial draft of tagging standards #25
Open
spikeheap
wants to merge
11
commits into
main
Choose a base branch
from
tagging-standards
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+157
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a work in progress initial draft of the tagging standards for AWS, based on https://github.com/LBHackney-IT/aws-tags-lbh and https://docs.google.com/document/d/1iWsgVYWXAbZQZDYP4PJ-Gv74rFRQUSdDC_XHHSiliXk/edit?pli=1&tab=t.0.
spikeheap
force-pushed
the
tagging-standards
branch
from
January 14, 2025 11:05
33e6582
to
a39b180
Compare
Because it's the landing page for this section of the documentation
This saves users from needing to open the tree. We may reconsider this is we get lots of content, but for now it's unneccessary
spikeheap
force-pushed
the
tagging-standards
branch
from
January 15, 2025 12:22
3aef3b8
to
3548181
Compare
stonest
reviewed
Jan 15, 2025
Co-authored-by: Stuart Stone <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a work in progress initial draft of the tagging standards for AWS, based on https://github.com/LBHackney-IT/aws-tags-lbh and https://docs.google.com/document/d/1iWsgVYWXAbZQZDYP4PJ-Gv74rFRQUSdDC_XHHSiliXk/edit?pli=1&tab=t.0.
Why this PR?
We need to keep track of the resources we're running in AWS to meet our security obligations:
All of this is currently tricky. We use tagging inconsistently across the estate, so some things can be reported on easier than others.
This PR introduces a baseline standard that consolidates the rules around tagging, but that introduces a new problem: what are the specific steps a developer needs to take for a system to be consistent with our approach?
This PR addresses both of those issues, following the Diataxis approach to technical documentation authoring.
Changes
This change adds:
Other areas of the site include content which could be a requirement or standard, however they're interspersed with other types of content and many are not current (or at least, not followed). This is an attempt to start archiving the old, irrelevant content and documenting the current standards we work to.
This first commit is very much a work in progress, for comments and iteration.
Things to do if this PR is merged:
AutomationTool
: The tool used for Infrastructure as Code, e.g.Terraform
orServerless Framework
.Phase
Stack
Patch Group
Project
OOOShutdown
(has been superceded)Team
(replaced by TeamEmail)OOHShutdown
andWeekendShutdown
tagsOOHShutdown
andWeekendShutdown
and deprecateooh_shutdown
andweekend_shutdown